<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>lwIP: api_msg Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">lwIP
   &#160;<span id="projectnumber">2.1.2</span>
   </div>
   <div id="projectbrief">Lightweight IP stack</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structapi__msg.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">api_msg Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;api_msg.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:abec5e33802d69f1b601543d60699f028"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structnetconn.html">netconn</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structapi__msg.html#abec5e33802d69f1b601543d60699f028">conn</a></td></tr>
<tr class="separator:abec5e33802d69f1b601543d60699f028"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c66bd95217fa627f13f2f0847bbb25f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structapi__msg.html#a8c66bd95217fa627f13f2f0847bbb25f">err</a></td></tr>
<tr class="separator:a8c66bd95217fa627f13f2f0847bbb25f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef71459b5251d796434f741ca630d528"><td class="memItemLeft" >union {</td></tr>
<tr class="memitem:a4b3f4b921f7d95aace6d59656f6423d5"><td class="memItemLeft" >&#160;&#160;&#160;struct <a class="el" href="structnetbuf.html">netbuf</a> *&#160;&#160;&#160;<a class="el" href="structapi__msg.html#ab0abd60527e96cc24c2c20c835cdac05">b</a></td></tr>
<tr class="separator:a4b3f4b921f7d95aace6d59656f6423d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c31b98d3203137d2d57df9a2c4e0e12"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:a7c31b98d3203137d2d57df9a2c4e0e12"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structapi__msg.html#adbbfc2baa8088b31fc722365237e5807">n</a></td></tr>
<tr class="separator:a7c31b98d3203137d2d57df9a2c4e0e12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07719d511c7737ead9d19f83a91a7e49"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:a07719d511c7737ead9d19f83a91a7e49"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structapi__msg.html#a1705127c6cd22c2c6dbbcc59834e41e0">bc</a></td></tr>
<tr class="separator:a07719d511c7737ead9d19f83a91a7e49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8b7047653a2722b94f559cb549966f6"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:aa8b7047653a2722b94f559cb549966f6"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structapi__msg.html#a36dedcbd9ecca67043a8e1d1e715be94">ad</a></td></tr>
<tr class="separator:aa8b7047653a2722b94f559cb549966f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1226d50647bc5a0431adbfbaf1dd450"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:a20e17a02c95bf44d80a92aaf3a8bf95e"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;const struct <a class="el" href="structnetvector.html">netvector</a> *&#160;&#160;&#160;<a class="el" href="structapi__msg.html#a1ceb9822ba49ba439e30d98492593612">vector</a></td></tr>
<tr class="separator:a20e17a02c95bf44d80a92aaf3a8bf95e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96c09ae2234151a29c3f6a4a9aa16a53"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;u16_t&#160;&#160;&#160;<a class="el" href="structapi__msg.html#ab6f14157a3e6735b69a569249d3286a2">vector_cnt</a></td></tr>
<tr class="separator:a96c09ae2234151a29c3f6a4a9aa16a53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa1b53759c1b1a4b27ca3d2aa4395443"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;size_t&#160;&#160;&#160;<a class="el" href="structapi__msg.html#a6896ae78ebddefdf2d8358ab5f21f444">vector_off</a></td></tr>
<tr class="separator:afa1b53759c1b1a4b27ca3d2aa4395443"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa117e5e841efeedc4a904e1e92d69700"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;size_t&#160;&#160;&#160;<a class="el" href="structapi__msg.html#a40624c398d1939bfee54bffa708a363e">len</a></td></tr>
<tr class="separator:aa117e5e841efeedc4a904e1e92d69700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a756b5c1fec59e5cc4a9f7394b5f1676f"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;size_t&#160;&#160;&#160;<a class="el" href="structapi__msg.html#a4bd9382dd42b18120803e246a0203353">offset</a></td></tr>
<tr class="separator:a756b5c1fec59e5cc4a9f7394b5f1676f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1226d50647bc5a0431adbfbaf1dd450"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structapi__msg.html#a8a71456d1199d10af5c1d8760cc0ce73">w</a></td></tr>
<tr class="separator:ab1226d50647bc5a0431adbfbaf1dd450"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb83f179e2d9b908cee2e193a5dca341"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:acb83f179e2d9b908cee2e193a5dca341"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structapi__msg.html#aebd72e07e711e7135294563b82c98cdf">r</a></td></tr>
<tr class="separator:acb83f179e2d9b908cee2e193a5dca341"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b0349f1bc8f08056eff2de65644bc28"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:a4b0349f1bc8f08056eff2de65644bc28"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structapi__msg.html#ad5e8bf133bc5ba4c78822af297330ce4">sd</a></td></tr>
<tr class="separator:a4b0349f1bc8f08056eff2de65644bc28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae8ee876cff38abe9517876271b1681e"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:aae8ee876cff38abe9517876271b1681e"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structapi__msg.html#a6387bddb309c218ac0ccc5ef6d7a033e">jl</a></td></tr>
<tr class="separator:aae8ee876cff38abe9517876271b1681e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef71459b5251d796434f741ca630d528"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structapi__msg.html#aef71459b5251d796434f741ca630d528">msg</a></td></tr>
<tr class="separator:aef71459b5251d796434f741ca630d528"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This struct includes everything that is necessary to execute a function for a netconn in another thread context (mainly used to process netconns in the tcpip_thread context to be thread safe). </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a36dedcbd9ecca67043a8e1d1e715be94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36dedcbd9ecca67043a8e1d1e715be94">&#9670;&nbsp;</a></span>ad</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct { ... }   api_msg::ad</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>used for lwip_netconn_do_getaddr </p>

</div>
</div>
<a id="ab0abd60527e96cc24c2c20c835cdac05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0abd60527e96cc24c2c20c835cdac05">&#9670;&nbsp;</a></span>b</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structnetbuf.html">netbuf</a>* api_msg::b</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>used for lwip_netconn_do_send </p>

</div>
</div>
<a id="a1705127c6cd22c2c6dbbcc59834e41e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1705127c6cd22c2c6dbbcc59834e41e0">&#9670;&nbsp;</a></span>bc</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct { ... }   api_msg::bc</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>used for lwip_netconn_do_bind and lwip_netconn_do_connect </p>

</div>
</div>
<a id="abec5e33802d69f1b601543d60699f028"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abec5e33802d69f1b601543d60699f028">&#9670;&nbsp;</a></span>conn</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structnetconn.html">netconn</a>* api_msg::conn</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The netconn which to process - always needed: it includes the semaphore which is used to block the application thread until the function finished. </p>

</div>
</div>
<a id="a8c66bd95217fa627f13f2f0847bbb25f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c66bd95217fa627f13f2f0847bbb25f">&#9670;&nbsp;</a></span>err</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> api_msg::err</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The return value of the function executed in tcpip_thread. </p>

</div>
</div>
<a id="a6387bddb309c218ac0ccc5ef6d7a033e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6387bddb309c218ac0ccc5ef6d7a033e">&#9670;&nbsp;</a></span>jl</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct { ... }   api_msg::jl</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>used for lwip_netconn_do_join_leave_group </p>

</div>
</div>
<a id="a40624c398d1939bfee54bffa708a363e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40624c398d1939bfee54bffa708a363e">&#9670;&nbsp;</a></span>len</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t api_msg::len</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>total length across vectors </p>

</div>
</div>
<a id="aef71459b5251d796434f741ca630d528"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef71459b5251d796434f741ca630d528">&#9670;&nbsp;</a></span>msg</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">union { ... }   api_msg::msg</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Depending on the executed function, one of these union members is used </p>

</div>
</div>
<a id="adbbfc2baa8088b31fc722365237e5807"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbbfc2baa8088b31fc722365237e5807">&#9670;&nbsp;</a></span>n</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct { ... }   api_msg::n</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>used for lwip_netconn_do_newconn </p>

</div>
</div>
<a id="a4bd9382dd42b18120803e246a0203353"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bd9382dd42b18120803e246a0203353">&#9670;&nbsp;</a></span>offset</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t api_msg::offset</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>offset into total length/output of bytes written when err == ERR_OK </p>

</div>
</div>
<a id="aebd72e07e711e7135294563b82c98cdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebd72e07e711e7135294563b82c98cdf">&#9670;&nbsp;</a></span>r</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct { ... }   api_msg::r</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>used for lwip_netconn_do_recv </p>

</div>
</div>
<a id="ad5e8bf133bc5ba4c78822af297330ce4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5e8bf133bc5ba4c78822af297330ce4">&#9670;&nbsp;</a></span>sd</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct { ... }   api_msg::sd</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>used for lwip_netconn_do_close (/shutdown) </p>

</div>
</div>
<a id="a1ceb9822ba49ba439e30d98492593612"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ceb9822ba49ba439e30d98492593612">&#9670;&nbsp;</a></span>vector</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const struct <a class="el" href="structnetvector.html">netvector</a>* api_msg::vector</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>current vector to write </p>

</div>
</div>
<a id="ab6f14157a3e6735b69a569249d3286a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6f14157a3e6735b69a569249d3286a2">&#9670;&nbsp;</a></span>vector_cnt</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16_t api_msg::vector_cnt</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>number of unwritten vectors </p>

</div>
</div>
<a id="a6896ae78ebddefdf2d8358ab5f21f444"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6896ae78ebddefdf2d8358ab5f21f444">&#9670;&nbsp;</a></span>vector_off</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t api_msg::vector_off</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>offset into current vector </p>

</div>
</div>
<a id="a8a71456d1199d10af5c1d8760cc0ce73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a71456d1199d10af5c1d8760cc0ce73">&#9670;&nbsp;</a></span>w</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct { ... }   api_msg::w</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>used for lwip_netconn_do_write </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/include/lwip/priv/<a class="el" href="api__msg_8h.html">api_msg.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structapi__msg.html">api_msg</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
